Skip to content

docs(examples): community example — vouchdev/vouch issue-tracker audit#357

Draft
jonathanchang31 wants to merge 2 commits into
vouchdev:testfrom
jonathanchang31:docs/example-vouch-issue-tracker-audit
Draft

docs(examples): community example — vouchdev/vouch issue-tracker audit#357
jonathanchang31 wants to merge 2 commits into
vouchdev:testfrom
jonathanchang31:docs/example-vouch-issue-tracker-audit

Conversation

@jonathanchang31

Copy link
Copy Markdown
Contributor

Summary

Adds examples/community/vouch-issue-tracker-audit/, a real vouch KB
built by cross-referencing every open issue on this repo (93 at audit
time) against upstream/main and upstream/test for a commit that
already resolves it.

Findings:

Every claim went through the real CLI (vouch propose-claimvouch approve, one round of vouch reject on a bad --type value, then
resubmit) and cites a source file with the actual evidence (a git log
transcript, a direct code excerpt, or a maintainer's PR-review comment
copied from GitHub) — nothing here is hand-authored YAML.

Related Issue

Addresses #338 (a standing call for community examples, not something a
single PR should close).

Change Type

  • Documentation / example update
  • Bug fix
  • New feature
  • Breaking change

Real Behavior Proof

A fresh copy of the shipped snapshot reconciles cleanly:

$ cp -r examples/community/vouch-issue-tracker-audit/vouch ./.vouch
$ vouch reindex
reindex: FTS5 rebuilt
$ vouch doctor
{'claims': 15, 'pages': 3, 'sources': 15, 'entities': 0, 'relations': 0,
 'sessions': 0, 'pending_proposals': 0, 'audit_events': 92, 'index_present': True}
$ vouch lint
clean
$ vouch fsck
clean

Checklist

  • Checked issue docs(examples): call for real-world example kbs — screenshots and verifiable proof #338's acceptance criteria and matched the submission shape
  • Every claim proposed and approved through the real CLI, cited to a source
  • vouch doctor / lint / fsck clean on the snapshot, both in-place and from a fresh copy
  • No PII, customer names, or internal URLs (all citations are public GitHub issues or this repo's own source)
  • Added a row to examples/README.md under a new "Community examples" section
  • Updated CHANGELOG.md under [Unreleased]
  • Ran full test suite (pytest) — unaffected, all green
  • Ran make lint

Adds examples/community/vouch-issue-tracker-audit/, a real vouch KB built
by cross-referencing every open issue on vouchdev/vouch against
upstream/main and upstream/test for a resolving commit. 13 of the 93 open
issues checked turned out to be already fixed but left open on GitHub, or
genuinely open and unclaimed; one (vouchdev#168, cross-agent approval bypassing
the review gate) is still unfixed and security-relevant, with a prior
maintainer review on record describing exactly what a correct fix needs.
A 14th finding, a real bug in `vouch source add --url`, surfaced while
building the KB itself.

Every claim is proposed and approved through the real CLI and cited to a
source file containing the actual evidence (git log output, direct code
reads, or a maintainer's PR review comment) — no hand-authored artifacts.

Closes vouchdev#338.
@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: bb5a90c5-2a91-4e0a-9d5a-f93fb73482b4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines labels Jul 4, 2026
@jonathanchang31 jonathanchang31 marked this pull request as draft July 4, 2026 07:25
Addresses CodeRabbit's review on PR vouchdev#358:
- The README and both audit pages said "every open issue" was checked,
  which contradicted the very next sentence excluding issues already tied
  to another open PR. Reworded to state the actual in-scope set: 61 of 93
  open issues, i.e. all except those already claimed by an in-flight PR.
- The "11 of these 13 issues ... already resolved" summary double-counted
  vouchdev#54 and vouchdev#100 as fully fixed. vouchdev#54's epic only shipped one of several
  tracks, and vouchdev#100 only drafted a VEP document without building the
  feature it describes. Corrected to "9 of these 13", with vouchdev#54 and vouchdev#100
  now called out explicitly as partial, alongside the already-separate
  vouchdev#189 (open) and vouchdev#168 (unfixed) callouts.

The corresponding decided/ proposal records are updated to match the
corrected page text, so the audit trail stays internally consistent
(payload.body in decided/ mirrors the durable pages/*.md content, per
`vouch doctor`/`fsck`).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant